Align Java API with other languages #1560

mcruzdev · 2025-09-20T20:02:49Z

Description

This pull request aims to align the Java SDK Workflow API woth other languages (Python, C#, etc.)

What this pull request does:

Deprecate waitForInstanceStart, getInstanceState and waitForInstanceCompletion.
Change the documentation to use the new methods (waitForWorkflowStart, getWorkflowState and waitForWorkflowCompletion)
Change test to use the new methods.

Issue reference

Closes #1554

Please reference the issue this PR will close: #[issue number]

Checklist

Please make sure you've completed the relevant tasks for this PR, out of the following list:

Code compiles correctly
Created/updated tests
Extended the documentation

siri-varma · 2025-09-22T05:36:36Z

@mcruzdev The patch coverage is failing. Looks like some more unit tests are needed.

siri-varma · 2025-09-22T05:38:14Z

LGTM. Can be merged once the patch succeedes

artur-ciocanu

@mcruzdev thanks a lot for looking into this.

I would like to request changes and suggest some improvements:

There is another method in the DaprWorkflowClient which uses instance purgeInstance I think it should be renamed to purgeWorkflow to stay consistent with other API changes.
We should add a new interface named WorkflowState that should be similar to WorkflowInstanceStatus and we should ensure that instead of getInstanceId we use getWorkflowId
Once you have the new interface you should adjust the implementation to ensure that the new methods use the new interface.
You will also have to add an implementation similar to DefaultWorkflowInstanceStatus but for WorkflowState something like DefaultWorkflowState.
One more thing I think we should adjust Java Docs to use workflowId instead of instanceId so we have a more clean API description.

I know it is a little bit more work, but I think it is totally worth it if we want to align with other SDKs.

Thank you 🙇

CC: @salaboy @cicoyle

mcruzdev · 2025-10-02T18:20:39Z

Hi @artur-ciocanu, I applied all requested changes, let me know if we have something wrong :)

artur-ciocanu

@mcruzdev love it ❤️ ! I have left a tiny comment related to docs. You should make sure that those are aligned with your changes.

Also we need to make sure the build is 🟢.

daprdocs/content/en/java-sdk-docs/java-client/_index.md

daprdocs/content/en/java-sdk-docs/java-workflow/java-workflow-howto.md

artur-ciocanu · 2025-10-03T17:19:09Z

@mcruzdev could you please check the test you added. I see these details in the build logs:

05:40:09.322 [main] INFO  i.d.i.t.workflows.DaprWorkflowsIIT - Starting DaprWorkflowsIIT using Java 17.0.16 with PID 19986 (started by runner in /home/runner/work/java-sdk/java-sdk/sdk-tests)

And then we have a long list of these:

time="2025-10-03T05:40:09.623842519Z" level=debug msg="Error for operation DaprBuiltInActorNotFoundRetries was: failed to lookup actor: api error: code = FailedPrecondition desc = did not find address for actor" app_id=workflow-dapr-app instance=7def0498f830 scope=dapr.runtime type=log ver=1.16.0-rc.5

05:40:14.099 [Thread-443] INFO  io.dapr.durabletask - The sidecar at address 127.0.0.1:32941 is unavailable. Will continue retrying.
05:40:14.099 [Thread-441] INFO  io.dapr.durabletask - The sidecar at address 127.0.0.1:32941 is unavailable. Will continue retrying.
05:40:14.099 [Thread-442] INFO  io.dapr.durabletask - The sidecar at address 127.0.0.1:32941 is unavailable. Will continue retrying.
05:40:14.099 [Thread-444] INFO  io.dapr.durabletask - The sidecar at address 127.0.0.1:32941 is unavailable. Will continue retrying.
05:40:14.619 [Thread-462] INFO  io.dapr.durabletask - The sidecar at address 127.0.0.1:32941 is unavailable. Will continue retrying.
time="2025-10-03T05:40:15.627565918Z" level=warning msg="Error processing operation DaprBuiltInActorNotFoundRetries. Retrying in 1s…" app_id=workflow-dapr-app instance=7def0498f830 scope=dapr.runtime type=log ver=1.16.0-rc.5

And eventually the task timeouts.

mcruzdev · 2025-10-04T14:59:42Z

Yes, checking today

mcruzdev · 2025-10-04T19:56:41Z

@mcruzdev could you please check the test you added. I see these details in the build logs:

05:40:09.322 [main] INFO  i.d.i.t.workflows.DaprWorkflowsIIT - Starting DaprWorkflowsIIT using Java 17.0.16 with PID 19986 (started by runner in /home/runner/work/java-sdk/java-sdk/sdk-tests)

And then we have a long list of these:

time="2025-10-03T05:40:09.623842519Z" level=debug msg="Error for operation DaprBuiltInActorNotFoundRetries was: failed to lookup actor: api error: code = FailedPrecondition desc = did not find address for actor" app_id=workflow-dapr-app instance=7def0498f830 scope=dapr.runtime type=log ver=1.16.0-rc.5

05:40:14.099 [Thread-443] INFO  io.dapr.durabletask - The sidecar at address 127.0.0.1:32941 is unavailable. Will continue retrying.
05:40:14.099 [Thread-441] INFO  io.dapr.durabletask - The sidecar at address 127.0.0.1:32941 is unavailable. Will continue retrying.
05:40:14.099 [Thread-442] INFO  io.dapr.durabletask - The sidecar at address 127.0.0.1:32941 is unavailable. Will continue retrying.
05:40:14.099 [Thread-444] INFO  io.dapr.durabletask - The sidecar at address 127.0.0.1:32941 is unavailable. Will continue retrying.
05:40:14.619 [Thread-462] INFO  io.dapr.durabletask - The sidecar at address 127.0.0.1:32941 is unavailable. Will continue retrying.
time="2025-10-03T05:40:15.627565918Z" level=warning msg="Error processing operation DaprBuiltInActorNotFoundRetries. Retrying in 1s…" app_id=workflow-dapr-app instance=7def0498f830 scope=dapr.runtime type=log ver=1.16.0-rc.5

And eventually the task timeouts.

I need to investigate, I just copied the old test using the new API naming.

artur-ciocanu · 2025-10-14T15:47:49Z

@mcruzdev I was wondering if you have any updates. Thank you.

mcruzdev · 2025-10-15T13:00:43Z

Hi @artur-ciocanu, apologies if I missed something. Could you please clarify what’s needed to move this pull request forward?

artur-ciocanu · 2025-10-19T01:35:46Z

@mcruzdev there are two checks that are failing, one for Spring Boot 3.4 and the other one for Spring Boot 3.5.

As far as I can tell the build for both of these is timing out after 30 mins.

The build logs says that DurableTask is trying to connect to Dapr sidecar and that is unavailable on a particular port.

Could you please take a look and let me know if you need any help.

Thank you.

artur-ciocanu · 2025-10-20T00:23:32Z

@mcruzdev could you please resolve the conflicts and it should be good to merge.

Thank you

Signed-off-by: Matheus Cruz <matheuscruz.dev@gmail.com>

Signed-off-by: artur-ciocanu <artur.ciocanu@gmail.com>

artur-ciocanu

@mcruzdev great job! Thanks a lot for all the effort!

artur-ciocanu · 2025-10-20T03:55:30Z

@dapr/approvers-java-sdk could you please approve. Thank you!

codecov · 2025-10-20T04:04:14Z

Codecov Report

❌ Patch coverage is 84.84848% with 5 lines in your changes missing coverage. Please review.
✅ Project coverage is 78.44%. Comparing base (d759c53) to head (084ca34).
⚠️ Report is 230 commits behind head on master.

Files with missing lines	Patch %	Lines
...a/io/dapr/workflows/client/DaprWorkflowClient.java	50.00%	1 Missing and 4 partials ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##             master    #1560      +/-   ##
============================================
+ Coverage     76.91%   78.44%   +1.53%     
- Complexity     1592     1929     +337     
============================================
  Files           145      216      +71     
  Lines          4843     5860    +1017     
  Branches        562      656      +94     
============================================
+ Hits           3725     4597     +872     
- Misses          821      926     +105     
- Partials        297      337      +40

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

* Align Java API with other languages Signed-off-by: Matheus Cruz <matheuscruz.dev@gmail.com> * Update documentation Signed-off-by: Matheus Cruz <matheuscruz.dev@gmail.com> * Change return type of waitForWorkflowStart method Signed-off-by: artur-ciocanu <artur.ciocanu@gmail.com> --------- Signed-off-by: Matheus Cruz <matheuscruz.dev@gmail.com> Signed-off-by: artur-ciocanu <artur.ciocanu@gmail.com> Co-authored-by: artur-ciocanu <artur.ciocanu@gmail.com> Signed-off-by: salaboy <Salaboy@gmail.com>

mcruzdev requested review from a team as code owners September 20, 2025 20:02

mcruzdev force-pushed the issue-1554 branch from f7ef1a9 to 592b883 Compare September 20, 2025 20:06

This comment was marked as duplicate.

Sign in to view

artur-ciocanu requested changes Sep 26, 2025

View reviewed changes

mcruzdev force-pushed the issue-1554 branch from 7d40e76 to 96eb34e Compare September 30, 2025 12:35

mcruzdev requested a review from artur-ciocanu September 30, 2025 13:08

artur-ciocanu previously approved these changes Oct 3, 2025

View reviewed changes

mcruzdev dismissed artur-ciocanu’s stale review via 6033ba2 October 4, 2025 19:52

mcruzdev force-pushed the issue-1554 branch 3 times, most recently from 3db364c to 9241389 Compare October 19, 2025 20:49

Align Java API with other languages

210643b

Signed-off-by: Matheus Cruz <matheuscruz.dev@gmail.com>

mcruzdev force-pushed the issue-1554 branch from be52fbd to 210643b Compare October 20, 2025 01:58

Update documentation

e8d9394

Signed-off-by: Matheus Cruz <matheuscruz.dev@gmail.com>

artur-ciocanu added the auto-merge label Oct 20, 2025

Change return type of waitForWorkflowStart method

084ca34

Signed-off-by: artur-ciocanu <artur.ciocanu@gmail.com>

artur-ciocanu approved these changes Oct 20, 2025

View reviewed changes

dapr-bot merged commit 81e1279 into dapr:master Oct 20, 2025
10 checks passed

mcruzdev deleted the issue-1554 branch October 20, 2025 13:54

Align Java API with other languages #1560

Align Java API with other languages #1560

Conversation

mcruzdev commented Sep 20, 2025

Description

Issue reference

Checklist

Uh oh!

siri-varma commented Sep 22, 2025

Uh oh!

siri-varma commented Sep 22, 2025

Uh oh!

This comment was marked as duplicate.

Uh oh!

artur-ciocanu left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mcruzdev commented Oct 2, 2025

Uh oh!

artur-ciocanu left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

artur-ciocanu commented Oct 3, 2025

Uh oh!

mcruzdev commented Oct 4, 2025

Uh oh!

mcruzdev commented Oct 4, 2025

Uh oh!

artur-ciocanu commented Oct 14, 2025

Uh oh!

mcruzdev commented Oct 15, 2025

Uh oh!

artur-ciocanu commented Oct 19, 2025

Uh oh!

artur-ciocanu commented Oct 20, 2025

Uh oh!

artur-ciocanu left a comment

Choose a reason for hiding this comment

Uh oh!

artur-ciocanu commented Oct 20, 2025

Uh oh!

Uh oh!

codecov bot commented Oct 20, 2025

Codecov Report

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

artur-ciocanu left a comment •

edited

Loading